home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / STUTTGART / SOUND / PLAYTRAC00 / !PlayTrack / Docs / Manual < prev   
Text File  |  1994-01-29  |  15KB  |  333 lines

  1.  
  2. System PlayTrack version 1.06 Mk II
  3. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  4. © David J Seery 1993
  5.  
  6. Licence agreement
  7. -----------------
  8. This has been changed from previous versions! See the 'License' file for
  9. details of your rights and responsibilties.
  10.  
  11. Disclaimer
  12. ----------
  13. This software is provided "as is"; no warranty, express or implied, is given
  14. as to the merchantability of this software or its fitness for any given
  15. purpose.  No responsibility can be taken by either the author or any
  16. distributers of this software regarding loss of time, data, profits, staff,
  17. media, or anything else due to the direct or indirect use or misuse of
  18. this software.
  19.  
  20. Although the software has been tested thoroughly it should be said that the
  21. testing was carried out on a base model machine - an A310 with a single
  22. floppy and Risc OS 2, with 1Mb, so no guarantees as regards multiscan
  23. monitors, Risc OS 3, A4s etc., can be made.  However as !PlayTrack does
  24. everything legally it should work on any configuration.
  25.  
  26. -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-
  27.  
  28. Introduction
  29. ------------
  30. !PlayTrack was written to fill a gaping hole in Archimedes SoundTracker
  31. (and Tracker) playback routines: there are virtually no players around that
  32. can give the (experienced) user analysis and details on the Tracker module
  33. being played, while allowing a more basic user to use the software at a
  34. simpler level.
  35.  
  36. !PlayTrack was written with the object of achieving both of these goals and
  37. in its present incarnation is a fairly good player but it should be noted
  38. that you can't actually write or score music with !PlayTrack: only playback
  39. what somebody else has actually written.
  40.  
  41. The controls provided by the system are deliberately like a cassette or
  42. video recorder: fast forward, rewind, pause, stop, and play, all are
  43. supported along with a volume control.
  44.  
  45. In this document, we will examine the menu that !PlayTrack provides
  46. (there is only one main menu: the iconbar menu) and then each window in
  47. turn, explaining its features and how to use it, and perhaps at this point
  48. it would be advantageous to list the features that !PlayTrack provides.
  49.  
  50.         o       Rewind, Pause, Stop, Play and Fast Forward
  51.         o       Pattern position counter
  52.         o       Internal speaker toggle
  53.         o       Mute button
  54.         o       Volume control
  55.         o       Module and tune statistics
  56.         o       8 channel playback and stereo positioning
  57.         o       Independant stereo
  58.         o       Detailed samples list
  59.         o       User controlled tune buffer
  60.         o       A variety of user preferences
  61.         o       A machine code redrawn 8 channel vu-meter
  62.         o       Display sample waveform and hear sample
  63.         o       Cathode Ray Oscilloscope display
  64.         o       Tune monitor
  65.         o       Save tune as Relocatable Module
  66.         o       Volume control
  67.         o       8 Channel individual mute
  68.         o       Sample rate control
  69.  
  70. This is, of course, only a brief list.
  71.  
  72. 1.1 The Main Menu
  73. -----------------
  74. The main menu is accessed from the iconbar and contains the entries
  75. Info, Open, Save, Stop, and Quit.  The first and last are largely self
  76. explanatory and are the standard Risc OS functions of this type.
  77. Open leads to a menu with 10 entries which allows you to open any of
  78. !PlayTrack's windows.  A keyboard short cut is also listed opposite each
  79. item.  The Save option leads to a dialogue box which will be explained in
  80. the section on saving a tune as a relocatable module; Stop halts the current
  81. tune according the the user preferences which are set in the Preferences
  82. dialogue.
  83.  
  84. The menu is fairly short as !PlayTrack's main features are accessed from the
  85. windows, and so it is to these that we must turn out attention.
  86.  
  87. 2.1 The Control Window (Shift-F1)
  88. ---------------------------------
  89. Along the top of this window are the five control icons for controlling the
  90. tune currently playing; below this is a position counter showing the current
  91. position (left) and the total number of positons (right).  Opposite this
  92. the tune name is displayed when one is playing.  Two toggles control the
  93. state of the internal speaker and the mute condition.  When the mute toggle
  94. is on, no sound is played, but when it is off (the normal condition) sound
  95. is buffered normally.  The red bar at the bottom of the window is the
  96. volume control.  Just slide it to the correct place to set the volume, it
  97. is (internally) on a scale of 1-127 but you need not worry about this.
  98. Below the red volume bar are 8 toggle buttons which control individual
  99. channel muting.  If a button is 'pressed' then that the corresponding
  100. channel is playing.  If it is 'released' then the channel is muted.
  101. Click over the buttons to change the state of each channel.  Next to these
  102. is the sample speed controller.  Click over the number with Select to
  103. increase it and Adjust to decrease it.  The speed is in the range 0-5
  104. and the numbers mean:
  105.  
  106.         0 - normal sample rate
  107.         1 - half sample rate
  108.         2 - normal sample rate (with VIDC enhancer)
  109.         3 - half sample rate (with VIDC enhancer)
  110.         4 - normal sample rate (with VGA modes)
  111.         5 - half sample rate (with VGA modes)
  112.  
  113. If option 1, 3 or 5 is selected, the sample quality is reduced, but 8 channel
  114. tunes will take up only a little more time than 4 channel tunes originally.
  115. Changine the speed alters the approximate ammount of CPU time spent playing
  116. the tune; if you select the wrong speed it may result in a loss of quality.
  117.  
  118. 2.2 The Tune Information Window (Shift-F2)
  119. ------------------------------------------
  120. This window is "static" which means it merely provides information about
  121. the tune and the user cannot interact with it.  The window lists the
  122. filename of the tune, and its size (both in bytes and kilobytes); the
  123. number of voices, patterns, and its speed; the tune name and its author;
  124. and the instruments and format it is in.
  125.  
  126. 2.3 The Stereo Positioning window (Shift-F3)
  127. --------------------------------------------
  128. This window affords the user overall control over the stero positioning.
  129. Unlike a lot of playback programs, and the poor Amoeba, !PlayTrack allows
  130. full 8 channel independant stereo (for tunes that use 8 channels!).
  131. Channels 1 to 4 are displayed along the top, with channels 5 to 8 at the
  132. bottom of the window.  Each channel can have 7 positions within its
  133. predetermined range; alter this by clicking on the left or right arrow on
  134. the appropriate side of the stereo positon display.
  135.  
  136. !PlayTrack is the only SoundTracker playback routine that I know of (in the
  137. PD) that has "sophisticated" facilities (that is, it isn't just a front end)
  138. that can handle 8 channel trackers.
  139.  
  140. 2.4 The Samples Window (Shift-F4)
  141. ---------------------------------
  142. This window allows you to view all the samples that a tune uses, but like
  143. the tune information window it is static and therefore non-interactive.
  144. The information listed for each tune is its number, name, volume, and
  145. length.
  146.  
  147. 2.5 The Buffer Control Window (Shift-F5)
  148. ----------------------------------------
  149. !PlayTrack maintains a buffer in RMA (the Relocatable Module Area) into
  150. which it loads tunes to be played.  The advantage of this mechanism is that
  151. the tune is assured of workspace in which it can be played.  This might
  152. not be available were !PlayTrack not to maintain this buffer.
  153. The major disadvantage is that the buffer has to be as large as your
  154. largest tune, and it is therefore not sensible for me to set the buffer to,
  155. say 400k (as big as my biggest tune) if the largest you have is 128k.
  156.  
  157. The buffer is therefore "dynamic", this means that you can alter it during
  158. the life of the program, although not, for obvious reasons, while a tune
  159. is playing.  To alter the size of the buffer, type the number you want
  160. into the writable icon at the top of the window and either press return
  161. or click on the "Intialise Buffer" bar.  This bar will slab in and the size
  162. of the buffer will be adjusted.  You can save this permanantly from the
  163. Preferences window.
  164.  
  165. Also displayed in this window is a "used" and "free" section so you can see
  166. how much you need to alter the buffer by, if need be.
  167.  
  168. 2.6 The Preferences Window (Shift-F6)
  169. -------------------------------------
  170. This window allows you to specify your own personal preferences to set
  171. !PlayTrack up to your way of working.  The options available are:
  172.  
  173.         o       Load and Play
  174.                 If set, after loading the tune will play.
  175.                 Default: On
  176.         o       Set clock rate
  177.                 If set, the sound system DMA clock will be set to the
  178.                 value in the writable icon on startup.
  179.                 Default: Off
  180.         o       Delete track on Stop
  181.                 If set, the track will be deleted when stop is clicked,
  182.                 otherwise playing will cease and the counter be reset
  183.                 to 0.
  184.                 Default: On
  185.         o       Auto filetype as STModule
  186.                 Tracker or SoundTracker tunes are available filetyped
  187.                 as a variety of types, and it helps if all are a uniform
  188.                 type.  !PlayTrack uses &CB6, STModule, as its standard
  189.                 format and if this is set, then all tunes will be
  190.                 set to this type after loading them.
  191.                 Default: Off
  192.         o       Mahoney & Kaktus scan
  193.                 If set, the 31 instrument format will be detected by an
  194.                 ASCII 'x' character in this file; otherwise a scan
  195.                 for the "M.K." string will be performed.  This string
  196.                 was introduced by Mssrs. Mahoney & Kaktus when they
  197.                 expanded the SoundTracker standard.
  198.                 Default: Off
  199.  
  200. These options can be saved permanantly by clicking the Save icon.  The
  201. buffer size is also saved with the options file.
  202.  
  203. 2.7 The Vu-Meter (Shift-F7)
  204. ---------------------------
  205. This is simply an 8 channel vu-meter with no really fancy touches or graphics
  206. but it does it's job.  One of the things to be improved, if I ever get
  207. round to it.  Looks pretty and impresses the boss.
  208.  
  209. 2.8 The Sample Waveform Window (Shift-F8)
  210. -----------------------------------------
  211. This is a useful tool for users who like to tinker, but it has a serious
  212. value as well.  While a tune is playing (or even paused) you can type a
  213. sample number you have looked up in the Samples window into the writable icon
  214. and press return: the waveform for the sample will then be drawn.  It will
  215. be too long to fit onto the screen, so a scrolling window is supplied
  216. instead.  The two vertical lines, if present, mark out the sample repeat
  217. start and end positions.
  218.  
  219. You can also hear the sample by clicking on the hear button.
  220.  
  221. 2.9 The Cathode Ray Oscilloscope Window (Shift-F9)
  222. --------------------------------------------------
  223. This (tiny) window displays the output from the channel displayed in the
  224. title bar on its rather garish green surface.  Still, that is what CRCs
  225. look like, so who am I to argue?
  226.  
  227. You can increment the channel number by pressing Select over the window,
  228. and decrement it by Adjust.
  229.  
  230. 2.10 The Monitor (Shift-F10)
  231. ----------------------------
  232. This is a bit of a stopgap until I can get a machine code one written,
  233. but it works, and that is the main thing!
  234.  
  235. 3.1 Saving a tune as a Relocatable Module
  236. -----------------------------------------
  237. You can save a tune as a relocatable module be either accessing the save
  238. window from the menu, or via F3.  The two toggle icons allow you to specify
  239. whether you would like the tune to autoplay after loading, and whether you
  240. want any * commands to be implemented.  After setting up your choices,
  241. drag the save icon to a directory viewer and the file will be saved.
  242. After this you just need a copy of the TrackerModule (from inside !PlayTrack)
  243. and you can then "play" the Relocatable Module.
  244.  
  245. The main use for this, I think, will be for programmers wanting to
  246. incorporate Tracker tunes into their games, but who don't know how.  You
  247. can easily do this using the Relocatable Modules and if you need to pause
  248. or stop the tune, the * commands will allow you to do this.
  249.  
  250. 4.1 The Keyboard Shortcuts
  251. --------------------------
  252. The F key shortcuts are only available if the pointer is in a PlayTrack
  253. window, this is because we don't want to pinch other program's keypresses!
  254. The full list is:
  255.  
  256.     F1   -   Internal speaker toggle
  257.     F2   -   Mute toggle
  258.     F3   -   Save dialogue
  259.     F4   -   Rewind
  260.     F5   -   Pause
  261.     F6   -   Stop
  262.     F7   -   Play
  263.     F8   -   Fast Forward
  264.     F9   -   Volume Down
  265.     F10  -   Volume Up
  266.     F11  -   Reset (Internal speaker off, mute off, volume to 100%, play on,
  267.                     counter reset to 0)
  268.  
  269. And for Shifted function keys:
  270.  
  271.     F1   -   Control window
  272.     F2   -   Tune information
  273.     F3   -   Stereo
  274.     F4   -   Samples
  275.     F5   -   Buffer
  276.     F6   -   Preferences
  277.     F7   -   Vu-meter
  278.     F8   -   Sample Waveform
  279.     F9   -   CRO
  280.     F10  -   Monitor
  281.  
  282. Pressing the function key for a corresponding window when it is open will
  283. close the window, so it acts like a toggle or flip-flop if you are used
  284. to electronic terms.
  285.  
  286. 4.2 The !Music Directory
  287. ------------------------
  288. Also supplied with !PlayTrack is a directory called !Music which is really
  289. a place to put your Tracker files.  You may need more than one if you've
  290. got a lot on floppies.  It keeps your root directory neat and tidy and
  291. looks good too!  Double click it to open up the directory viewer, as usual.
  292.  
  293. 4.3 CDs and PlayLists
  294. ---------------------
  295. Thanks to Colin McEwan for this idea.
  296.  
  297. If you drag a !Music Directory onto the !PlayTrack icon then !PlayTrack
  298. will play every tune in that directory in a cyclical fashion, without any
  299. user intervention - you can just sit back and enjoy the music!
  300. If you want something a little more complex then you can create a PlayList.
  301. This is a textfile (as created by !Edit) which simply lists all the tunes
  302. you want to play - but you must list the FULL pathnames, otherwise
  303. !PlayTrack will get confused.  When you drag this file to the icon
  304. !PlayTrack will pick a tune at random and play it, and then another at
  305. random when that has finished, and so on.  The tunes may be spread over
  306. several discs, and !PlayTrack will prompt you for the correct disc if
  307. necessary.
  308.  
  309. !PlayTrack now detects the end of a tune if the pattern position jumps
  310. to one which is smaller than the current one.  This avoids the problem
  311. of tunes which don't jump back to position 0 (eg Powerslave) but means
  312. that tunes which jump around all over the place may get unduly harsh
  313. treatment! Still, I think this newer way is better overall.
  314.  
  315. The easiest way to create the PlayList is to Shift-Drag the files into
  316. an !Edit window, this adds the pathnames at the cursor position.
  317.  
  318. 5.1 The End (!!)
  319. ----------------
  320. That is about all for this release: I hope you enjoy using the software
  321. and find it useful.
  322. Bug reports, comments (always welcome), ideas (please!), or anything else,
  323. should be addressed to:
  324.  
  325.   David J Seery
  326.   15 Farm Walk
  327.   Bents Farm Estate
  328.   Littleborough
  329.   Lancashire
  330.   OL15 8LJ
  331.  
  332. If you want a reply, please include a stamped, self-addressed envelope.
  333. Failure to enclose one may lead to a failiure to reply!